

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The requiredProperties module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The interfaces module" href="mod_pyamp_patterns_interfaces.html" />
    <link rel="next" title="The interface module" href="pyamp_patterns_interfaces_interface.html" />
    <link rel="prev" title="The finalFunctionsMeta module" href="pyamp_patterns_interfaces_finalFunctionsMeta.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_patterns_interfaces_interface.html" title="The interface module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_patterns_interfaces_finalFunctionsMeta.html" title="The finalFunctionsMeta module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_patterns.html" >The patterns module</a> &raquo;</li>
          <li><a href="mod_pyamp_patterns_interfaces.html" accesskey="U">The interfaces module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.patterns.interfaces.requiredProperties">
<span id="the-requiredproperties-module"></span><h1>The requiredProperties module<a class="headerlink" href="#module-pyamp.patterns.interfaces.requiredProperties" title="Permalink to this headline">¶</a></h1>
<p>The requiredProperties module contains a class which provides
an interface which allows a class to define a set of properties
which the subclasses are required to define. This class handles
checking that each of those required properties are defined and
throwing an error in the event that one of them is not defined.</p>
<div class="section" id="the-requiredproperties-class">
<h2>The RequiredProperties class<a class="headerlink" href="#the-requiredproperties-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-5fcb9641bd40126b83095e6d58bdbbc13f81898c.png" alt="Inheritance diagram of pyamp.patterns.interfaces.requiredProperties.RequiredProperties" usemap="#inheritanceb5e6cd1704" class="inheritance"/>
<map id="inheritanceb5e6cd1704" name="inheritanceb5e6cd1704">
<area shape="rect" href="#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.patterns.interfaces.requiredProperties.RequiredProperties">
<em class="property">class </em><tt class="descclassname">pyamp.patterns.interfaces.requiredProperties.</tt><tt class="descname">RequiredProperties</tt><a class="reference internal" href="../_modules/pyamp/patterns/interfaces/requiredProperties.html#RequiredProperties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="Permalink to this definition">¶</a></dt>
<dd><p>The RequiredProperties class provides an interface which allows
subclasses to define a set of properties that must be defined for
that class.</p>
<p>This class checks that all of those properties are defined, and if
one of them is not defined this class throws an exception.</p>
<p>Check that all the required properties are defined.</p>
<dl class="classmethod">
<dt id="pyamp.patterns.interfaces.requiredProperties.RequiredProperties.checkRequiredProperties">
<em class="property">classmethod </em><tt class="descname">checkRequiredProperties</tt><big>(</big><em>obj</em><big>)</big><a class="reference internal" href="../_modules/pyamp/patterns/interfaces/requiredProperties.html#RequiredProperties.checkRequiredProperties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.patterns.interfaces.requiredProperties.RequiredProperties.checkRequiredProperties" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The requiredProperties module</a><ul>
<li><a class="reference internal" href="#the-requiredproperties-class">The RequiredProperties class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_patterns_interfaces_finalFunctionsMeta.html"
                        title="previous chapter">The finalFunctionsMeta module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pyamp_patterns_interfaces_interface.html"
                        title="next chapter">The interface module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_patterns_interfaces_requiredProperties.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_patterns_interfaces_interface.html" title="The interface module"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_patterns_interfaces_finalFunctionsMeta.html" title="The finalFunctionsMeta module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_patterns.html" >The patterns module</a> &raquo;</li>
          <li><a href="mod_pyamp_patterns_interfaces.html" >The interfaces module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>